home *** CD-ROM | disk | FTP | other *** search
/ ftp.sunet.sepub/pictures / 2014.11.ftp.sunet.se-pictures.tar / ftp.sunet.se / pub / pictures / ACiD-artpacks / programs / mac / macrar201_sit.hqx / MacRAR 2.0.1 ƒ / MacRAR doc (draft) < prev    next >
Text File  |  1999-02-24  |  22KB  |  554 lines
  1.  
  2. ╩
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.                               User's Manual
  11.  
  12.  
  13.  
  14.                                Summary
  15.  
  16.     *  Introduction
  17.     *  Using MacRAR
  18.        1. Menus
  19.        2. Windows
  20.        3. Preferences
  21.     *  Glossary
  22.     *  Version History
  23.  
  24.  
  25.  
  26.                              Introduction
  27.  
  28.  
  29.   RAR is an extremely powerful tool which allows you to manage and
  30.   control archive files.
  31.  
  32.   RAR features include:-
  33.  
  34.     *  Highly sophisticated, original compression algorithm
  35.     *  Special compression algorithm optimized for multimedia data
  36.     *  Better compression than other tools using 'solid' archiving
  37.     *  Authenticity verification (registered version only)
  38.     *  Self-extracting archives and volumes (SFX)
  39.     *  Ability to recover physically damaged archives
  40.     *  locking, password, file order list, disk volume labels & more ...
  41.  
  42.   MacRAR features include:-
  43.  
  44.     *  Appearance Manager, Navigation Service compatibility
  45.     *  AppleScript compatibility
  46.     *  Full Drag╒n Drop
  47.     *  Cross-platforms conversions
  48.     *  Finder-like list view presentation
  49.     *  ...
  50.  
  51.   Requirements:-
  52.  
  53.     *  68k or PPC Macintosh
  54.     *  RAM 4 Mb at least for extracting, 8 Mb at least for packing
  55.     *  System 7 or later
  56.     *  Internet Config strongly recommended
  57.     *  Appearance Manager and Navigation Services recommanded
  58.  
  59.  
  60.   Configuring InternetConfig for MacRAR:-
  61.        In File Mapping Section, add a new item
  62.     *  Name : RAR archive
  63.     *  Extension : .rar
  64.     *  MIME Type : application/x-rar-compressed
  65.     *  Binary Data
  66.     *  File Type : RARf
  67.     *  File Creator : uRAR
  68.     *  choose Post Process by MacRAR if you wish to.
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.                                Using MacRAR
  76.  
  77. 1. Menus
  78.  
  79.    1.1.  File menu
  80.  
  81.     *  New                  Open a new archive window where you can add             
  82.                             files by dropping from Finder or selecting
  83.                             the item "Add..." from "Archive" menu.
  84.     *  Open...              Open an archive window showing the content of
  85.                             the archive you opened (using Navigation
  86.                             Services, you can open multiples RAR archives).
  87.     *  Extract...           Extract the archive you opened (using Navigation
  88.                             Services, you can open multiples RAR archives) at
  89.                             the location specified for Destination in the
  90.                             "Preferences..." item from "Edit" menu.
  91.     *  Get Info for ?       Open an archive information window (show this
  92.                             section).
  93.     *  Verify...            Verify the archive you opened (using Navigation
  94.                             Services, you can open multiples RAR archives).
  95.                             You will get an error message if the archive is
  96.                             corrupted.
  97.     *  Repair...            Try to repair corrupted archives.
  98.     *  Save                 Save the archive whose content is shown by the
  99.                             front window.
  100.     *  Save As              Save with a new name the archive whose content is
  101.                             shown by the front window.
  102.     *  Quit                 Guess...
  103.  
  104.  
  105.  
  106.    1.2.  Edit menu
  107.  
  108.     *  Select All           If an archive window is the front window, select
  109.                             all the items displayed.
  110.     *  Clear                Will remove the items you selected in the front 
  111.                             archive window from the archive when the archive
  112.                             will be saved. If the items belong to the archive
  113.                             their name will be crossed off, selecting again
  114.                             the "Clear" item will undo the action. If the items
  115.                             were added to the archive and the archive not saved,
  116.                             the items will disappear.
  117.     *  Preferences          Open the preference window (show this section).
  118.  
  119.  
  120.    1.3.  Archive menu
  121.  
  122.     *  Add...               Display a customized Open Dialog. The file you
  123.                             select here will be added to the front archive
  124.                             window. Press the "Add" button to add the item
  125.                             selected in the top list to the list of the 
  126.                             files to add (bottom list). Press "Remove" do
  127.                             remove a file selected from the bottom list.
  128.                             Press "Done" when finished.
  129.                             Pressing the "Open" button will only add the file
  130.                             selected from the bottom list!
  131.     *  Extract To...        Will extract the files you selected from the front
  132.                             archive window to the folder you will specify in
  133.                             the Select Folder dialog.
  134.     *  Test                 Test the integrity of the files you selected in
  135.                             the front archive window. You will get an error
  136.                             message if some items are corrupted.
  137.     *  Get Info             Open an archive item information window (show
  138.                             this section) for each item selected in the front
  139.                             archive window.
  140.     *  Edit Comments        Open comments (show this section) for the
  141.                             currently opened file.
  142.     *  Set Password         Set password for the currently opened file. At
  143.                             compression, all added files will be encrypted.
  144.                             At extraction, encrypted files will be decoded.
  145.  
  146.                             
  147.  
  148. 2. Windows
  149.  
  150.    2.1. Archive window
  151.  
  152.    This windows appears when you create a new archive by the "New" item of the
  153.    "File" Menu or when you open an archive from the "Open" item of the "File"
  154.    Menu.
  155.  
  156.    Using up an down keys, you can change the current selection.
  157.    If you press the Enter key and the item selected is a folder, its content
  158.    will be shown. If it is a file, it will be extracted in the default
  159.    destination folder.
  160.  
  161.    If you double-click on an item, if the item selected is a folder, its 
  162.    content will be shown. If it is a file, it will be extracted in the default
  163.    destination folder.
  164.  
  165.    You can select multiples files using Command or Shift key.
  166.  
  167.    You can sort the items displayed by clicking in the header of the column.
  168.  
  169.    In order to come back to a previously displayed folder, use the popup menu
  170.    at the bottom of the window.
  171.  
  172.  
  173.    The easiest way to manage files in MacRAR is to use Drag╒n Drop.
  174.  
  175.    Dropping files from an RAR archive window to a Finder window will extract
  176.    the items you dropped in the Finder window.
  177.  
  178.    Dropping files from a Finder window to a RAR archive window will add the
  179.    items you dropped in the archive. The compression is made only when saving
  180.    the archive (due to the long processing needed by solid archives). So, as
  181.    long as the archive is not saved, you should not move or delete the files
  182.    you dropped in the archive.
  183.  
  184.    You can not (yet) copy files from an archive to another. That should be
  185.    possible but it is not foreseen by the original RAR. I will see what I
  186.    can do.
  187.  
  188.  
  189.    2.2. Archive information window
  190.  
  191.  
  192.    Dialog Box:                      Meaning:
  193.  
  194.                     EXAMPLE.RAR     archive name
  195.  
  196.    Kind             Archive         not a 'solid' archive
  197.    Size             14917 bytes,    total length in bytes
  198.                     for 5 items     number of files (5)
  199.    Compressed       3938 bytes      length in archive
  200.    Gain             26%             compression ratio.  Now 26% of
  201.                                     original size.
  202.    Path             Mac HD:         location of the archive
  203.    Modified         98.12.12        date of the last modification
  204.    Dict. Size       64Kb            dictionary size
  205.    Host OS          DOS             OS used to create this archive
  206.  
  207.    Lock             not checked     archive is not locked
  208.    Auth. verif.     checked         authenticity verification is present
  209.  
  210.    Main comment     Present         archive comment present
  211.    File comments    Absent          no individual file comments
  212.    Passwords        Absent          no password encrypted files
  213.    Recovery data    Present         recovery record present
  214.    Version to extr. 2.00            minimum RAR version required to extract
  215.    Host OS          DOS             OS used to create this archive
  216.  
  217.  
  218.    2.3. Archive item information window
  219.  
  220.  
  221.    Dialog Box:                      Meaning:
  222.  
  223.                     RCVT.TXT        item name
  224.  
  225.    Kind             ASCII Text      kind of the item
  226.    Size             917 bytes       length in bytes
  227.    Compressed       512 bytes       length in archive
  228.    Gain             56%             compression ratio.  Now 26% of
  229.                                     original size.
  230.    Path             EXAMPLE.RAR     location in the archive
  231.    Modified         98.12.12        date of the last modification
  232.    Method           m3a,            method used to pack
  233.                     v 2.0           minimum RAR version required to extract
  234.    CRC              0870847C        CRC of the item
  235.    Attributes       MS DOS:         OS used to create this item
  236.                     .....A          attributes of the file (DOS archive)
  237.    Dict. Size       64Kb            dictionary size
  238.    Host OS          DOS             OS used to create this archive
  239.  
  240.    Protected        checked         item encrypted with a password
  241.  
  242.  
  243.    2.4. Comment window
  244.  
  245.    This windows allows you to edit or view comments of an archive.
  246.  
  247.    You can modify the encoding of the text or change font/size.
  248.  
  249.    The PC Ansi option allows you to view Ansi comments. You must have a
  250.    PC Ansi font such as the Markspace (TM) PC Ansi (ID 19200). Edit the
  251.    'FRSV' resource if you have another PC Ansi font.
  252.  
  253.  
  254. 3. Preferences
  255.  
  256.    3.1. Extraction
  257.  
  258.    When file already exists:-
  259.     *  Auto-rename          Save the extracted file with a non-existing name,
  260.                             adding 01, 02, ... until an unique name.
  261.     *  Skip                 Do not extract files for those a file with the same
  262.                             already exists in the Destination Folder.
  263.     *  Overwrite            Overwrite files for those a file with the same
  264.                             already exists in the Destination Folder.
  265.     *  Compare dates        Overwrite files for those a file with the same
  266.                             already exists in the Destination Folder only if
  267.                             the file to be extracted if newer than the file
  268.                             in the destination folder.
  269.     *  Ask                  Sure you have guessed again.
  270.  
  271.    Keep broken archives:-
  272.      MacRAR, by default, deletes files with CRC errors after extraction.
  273.  
  274.  
  275.    3.2. Destination
  276.  
  277.    Destination:-
  278.     *  Same as original     Extract files in the same folder where is the
  279.                             archive they are coming from.
  280.     *  Ask                  You are too good.
  281.     *  Use                  Specify a default destination folder for all
  282.                             extracted files.
  283.  
  284.    Create surrounding Folder:-
  285.     *  When the archive contains multiples items
  286.                             Create in the destination folder a new folder with 
  287.                             the name of the archive if the archive contains
  288.                             multiples items.
  289.     *  Ask                  Sure you have guessed again.
  290.  
  291.  
  292.    3.3. Compression
  293.  
  294.    Archiving:-
  295.     *  Make solid archives  Solid is a special archive type.  Please refer to
  296.                             the appendix "Glossary" for further information.
  297.     *  Multimedia compression
  298.                             Enables special compression designed for digital
  299.                             audio and some types of graphic.
  300.     *  Put recovery record  If this option is selected RAR will
  301.                             add recovery record to any new or modified
  302.                             archive.
  303.  
  304.        Optionally, redundant information (recovery record) may be added
  305.        to an archive, incurring a small penalty in archive size, which
  306.        will help to recover archived files in the case of floppy disk
  307.        failure or other data losses. A recovery record may contain up
  308.        to 8 recovery sectors. The number of sectors may be specified
  309.        directly or selected automatically according to the archive size:
  310.  
  311.                    Archive size       Number of sectors
  312.                      < 50Kb                   2
  313.                      50Kb-500Kb               4
  314.                      > 500Kb                  8
  315.  
  316.        If damaged data is continuous then each sector is able to
  317.        recover 512 bytes of damaged information, although this value
  318.        may decrease for multiple areas of damage.
  319.  
  320.        The size of the recovery record may be calculated
  321.        (approximately) as <archive size>/256 + <number of recovery
  322.        sectors>*512 bytes.
  323.  
  324.     *  Put Authenticity verification
  325.                             Forces RAR to place Authenticity
  326.                             Verification into archives when they are
  327.                             created. (This feature is only available in
  328.                             the registered version)
  329.  
  330.        RAR will put, in every new and updated archive, information
  331.        concerning the creator, last update time and archive name.
  332.  
  333.        If an archive, containing authenticity verification, is being
  334.        modified and this switch is not specified, the authenticity
  335.        verification information will be removed.
  336.  
  337.        When extracting, testing, listing or updating and archive with
  338.        the 'av' switch, RAR will perform integrity validation and
  339.        display the message:
  340.  
  341.             Verifying authenticity information ...
  342.  
  343.        In the case of successful authenticity verification, the message
  344.        'Ok', creator name and last update information will be
  345.        displayed.  In the case of authenticity verification failure,
  346.        the message 'FAILED' will be displayed.
  347.  
  348.        When creating archive volumes with the 'av' switch, Cyclic
  349.        Redundancy Check (CRC) information will be added to each volume.
  350.  
  351.        The Authenticity Verification feature, is recommended for
  352.        use with archives in a software distribution environment.
  353.  
  354.        In order to enable the Authenticity verification feature, the
  355.        program MUST be registered.  Please contact your local
  356.        distribution site or the world-wide distribution center.
  357.  
  358.  
  359.     *  Log errors to file   Enables the logging of critical errors
  360.                             to a file RAR.LOG. (This feature is only
  361.                             available in the registered version)
  362.  
  363.  
  364.    Compression:-
  365.     *  Level                Choose the default compression level
  366.  
  367.       Store ...... Do not compress file when adding to archive
  368.       Fastest .... Use fastest method (least compressive)
  369.       Fast ....... Use fast compression method
  370.       Normal ..... Use normal (default) compression method
  371.       Good ....... Use good compression method (more compressive)
  372.       Best ....... Use best compression method (most compressive)
  373.  
  374.    Default is 'Normal' and is chosen as the best compromise between
  375.    time taken and compression ratio achieved.  Marginally higher (0.1%
  376.    - 1.5%) compression may be achieved with 'Good' or 'Best', at the
  377.    expense of 10% - 100% longer processing time.
  378.  
  379.     *  Dictionnary size     Select dictionary size in Kb
  380.  
  381.        The sliding dictionary is a special memory area used by the
  382.        compression algorithm. If the size of the file being compressed
  383.        (or the total files size in the case of a solid archive) is
  384.        greater than the dictionary size, then increasing the dictionary
  385.        size will generally increase compression ratio, decrease packing
  386.        speed and increase memory requirements.  RAR for DOS has a fixed
  387.        dictionary size of 64 Kb.  RAR for OS/2 (and other 32-bit
  388.        platforms) has a default dictionary size of 256Kb, but this may
  389.        be changed by the user to be 64 Kb, 128 Kb, 256 Kb, 512 Kb or
  390.        1024 Kb.  Unlike compression, extraction speed is unaffected by
  391.        dictionary size.
  392.  
  393.        The amount of memory required to create large dictionary
  394.        archives may be calculated as 5*<dictionary size>+150Kb. About 1
  395.        Mb is required for extraction and 5*<dictionary size>+1150Kb to
  396.        update solid archives.
  397.  
  398.  
  399.    3.4. Cross Platform
  400.  
  401.    Files:-
  402.     *  Encode MacBinary     Encode in MacBinary III format Mac files. If
  403.                             "When necessary" option is selected, only
  404.                             files with a resource fork or TEXT files
  405.                             will be encoded.
  406.     *  Convert Text end of lines
  407.                             Convert end of lines (CR/LF) of files recognized
  408.                             as Text files.
  409.     *  Convert High ASCII chars
  410.                             Convert high ASCII characters of files recognized
  411.                             as Text files.
  412.  
  413.    Names:-
  414.     *  Add extension to Mac files
  415.                             Add an extension (such as .XLS for Excel files)
  416.                             to all Mac files according to their type.
  417.     *  Convert file names   Sure you have guessed again.
  418.  
  419.  
  420.  
  421.    3.5. RAR registration
  422.  
  423.    MacRAR is not really a freeware, nor a shareware. Indeed, it is new, 
  424.    it is both! MacRAR is made of two components, the RAR compression core
  425.    from Eugene Roshal and its Apple Macintosh implementation (the remaining,
  426.    mainly the interface and the modifications made to the RAR core) by
  427.    Guillaume Dufay. The RAR core is a shareware, and I (Guillaume Dufay)
  428.    decided with the author of RAR (Eugene Roshal) that it will remain a
  429.    shareware on Mac in order all platforms to be equal. However I want the
  430.    remaining to be a freeware. To sum up, you will register for RAR for
  431.    Macintosh and not for MacRAR. Always here? I should have made a 
  432.    shareware, that would have been easier...
  433.  
  434.    Please support shareware !
  435.  
  436.    To register RAR you must have a registration code.  This code may be
  437.    obtained by sending the completed registration form to your local
  438.    registration site or the world-wide distribution center.
  439.  
  440.    You will receive the latest version of RAR along with your
  441.    registration key and will then be able to create archives containing
  442.    Authenticity verification.
  443.  
  444.  
  445.  
  446.  
  447.                              Glossary
  448.  
  449.  
  450.    Archive       Special file containing one or more files optionally
  451.                  encoded and/or compressed.
  452.  
  453.    Compression   A method of encoding data to reduce it's size.
  454.  
  455.    CRC           Cyclic Redundancy Check. Mathematical method
  456.                  calculating special checking information for data
  457.                  validity.
  458.  
  459.    Dictionary    The length of a buffer used to search similarities
  460.    size          (the stage of a compression process) in a file been
  461.                  added to the archive.
  462.  
  463.    SFX           Archive module used to extract files from when
  464.                  executed. (SelF-eXtracting module), usually in the
  465.                  form of a .EXE file.
  466.  
  467.    Sliding       See the 'Dictionary size' description.
  468.    dictionary
  469.  
  470.    Solid         An archive packed using a special compression method
  471.                  which sees all files as one continuous data stream.
  472.                  Particularly advantageous when packing a large number
  473.                  of small files.
  474.  
  475.    Volume        Part of a split archive. Splitting an archive to
  476.                  volumes allows storing them on diskettes. Volumes must
  477.                  be extracted starting from first in sequence.
  478.  
  479.  
  480.  
  481.  
  482.                       MacRAR version history
  483.  
  484.  
  485.  
  486.  version 2.0.1:- 
  487.     *  Now based on RAR 2.5 (fastest compression and less memory used)
  488.     *  Fixed memory leaks
  489.     *  Improved Progress indicators
  490.     *  Now uses WinRAR registration codes
  491.  
  492.  version 2.0:-
  493.     *  Added remaining RAR functions (Repair, Comments, Lock, Encryption, ...)
  494.        and more (renaming)
  495.     *  Added text conversions
  496.     *  Added Mac information on archives
  497.     *  Improved Info windows
  498.     *  Improved Progress indicators
  499.     *  Corrected again many bugs (drag, about window, IC,...)
  500.     *  ...
  501.  
  502.   version 2.0 b1:-
  503.     *  Added RAR compression, based on RAR 2.05.
  504.     *  Added MacBinary III encoding.
  505.     *  Fixed (and added ?) many little bugs.
  506.     *  ...
  507.  
  508. MacRAR is known as MacUnRAR for version < 2.0
  509.  
  510.   version 1.2:-
  511.     *  Appearance Manager compatibility.
  512.     *  Navigation Services compatibility.
  513.     *  Internet Config 2.0 compatibility.
  514.     *  AppleScript compatibility (mail-me if you want more).
  515.     *  Better handling of segmented archives.
  516.  
  517.   version 1.2 b4 (not shipped):-
  518.     *  Better handling of files within lists.
  519.     *  Based on 2.04 version of UnRAR.
  520.     *  Better progrees bar indication.
  521.     *  Better non-solid archives extraction within lists.
  522.     *  Rewriting and simplification of many fonctions.
  523.     *  Fixed many bugs.
  524.  
  525.   version 1.2 b3:-
  526.     *  Added info windows.
  527.     *  Modified list presentation.
  528.     *  Fixed a bug with Dos dates conversion.
  529.     *  Better handling of events while extracting files.
  530.     *  Fixed bugs with Drag'n Drop.
  531.  
  532.   version 1.2 b2 (restricted PPC shipping):-
  533.     *  Deeply modified the handling of extracted files' hierarchy
  534.     *  Fixed a bug caused by long filenames (Windows 95).
  535.     *  Allows to test archives.
  536.  
  537.   version 1.2 b1 (not shipped):-
  538.     *  Fixed a bug which may cause CRC errors when extraction archive
  539.  
  540.      version 1.1.1:-
  541.     *  Added a list archives fonction.
  542.  
  543.   version 1.1:-
  544.     *  Added a preferences panel, enhanced code and fixed few bugs.
  545.  
  546.   version 1.0:-
  547.     *  Initial release.
  548.  
  549.  
  550.   Next improvments:-
  551.     *  Handling and visualisation of comments within lists
  552.     *  Text conversion
  553.     *  Whatever you would like to see in MacRAR
  554.